home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Libraries / C Internet Config / IC Component Source ƒ / IC Headers ƒ / IC API Descriptions.h < prev    next >
Encoding:
Text File  |  1995-11-17  |  21.4 KB  |  189 lines  |  [TEXT/SPM ]
  2. */
  3.  
  4. ICError ICSetPref(ICInstance inst,StringPtr key,ICAttr attr,Ptr buf,long size);
  5. /*
  6.     You must specify a configuration before calling this routine.
  7.     If you are getting or setting multiple preferences, you should place
  8.     these calls within an ICBegin/ICEnd pair.
  9.     If you call this routine outside of such a pair, it implicitly
  10.     calls ICBegin(inst, icReadWritePerm).
  11.     Sets the preference specified by key from the IC database to the
  12.     value pointed to by buf and size.
  13.     key must not be the empty string.
  14.     size must be non-negative. 
  15.     If buf is nil then the preference value is not set and size is ignored.
  16.     If buf is not nil then the preference value is set to the size
  17.     bytes pointed to by buf.
  18.     If attr is ICattr_no_change then the preference attributes are not set.
  19.     Otherwise the preference attributes are set to attr.
  20.     Returns icPermErr if the previous ICBegin was passed icReadOnlyPerm.
  21.     Returns icPermErr if current attr is locked, new attr is locked and buf <> nil.
  22. */
  23.  
  24. ICError ICFindPrefHandle(ICInstance inst,StringPtr key,ICAttr* attr,Handle prefh);
  25. /*
  26.     Requires IC 1.2.
  27.     You must specify a configuration before calling this routine.
  28.     If you are getting or setting multiple preferences, you should place
  29.     these calls within an ICBegin/ICEnd pair.
  30.     If you call this routine outside of such a pair, it implicitly
  31.     calls ICBegin(inst, icReadWritePerm).
  32.     This routine effectively replaces ICGetPrefHandle.
  33.     Reads the preference specified by key from the IC database into
  34.     a handle, prefh.
  35.     key must not be the empty string.
  36.     attr is set to the attributes associated with the preference.
  37.     You must set prefh to a non-nil handle before calling this routine.
  38.     If the preference does not exist, icPrefNotFoundErr is returned.
  39. */
  40.  
  41. ICError ICGetPrefHandle(ICInstance inst,StringPtr key,ICAttr* attr,Handle* prefh);
  42. /*
  43.     Requires IC 1.1.
  44.     You must specify a configuration before calling this routine.
  45.     If you are getting or setting multiple preferences, you should place
  46.     these calls within an ICBegin/ICEnd pair.
  47.     If you call this routine outside of such a pair, it implicitly
  48.     calls ICBegin(inst, icReadOnlyPerm).
  49.     This routine is now obsolete. Use ICFindPrefHandle instead.
  50.     Reads the preference specified by key from the IC database into
  51.     a newly created handle, prefh.
  52.     key must not be the empty string.
  53.     attr is set to the attributes associated with the preference.
  54.     The incoming value of prefh is ignored.
  55.     A new handle is created in the current heap and returned in prefh.
  56.     If the routine returns an error, prefh is set to nil.
  57.     If the preference does not exist, no error is returned and prefh is set
  58.     to an empty handle.
  59. */
  60.  
  61. ICError ICSetPrefHandle(ICInstance inst,StringPtr key,ICAttr attr,Handle prefh);
  62. /*
  63.     Requires IC 1.1.
  64.     You must specify a configuration before calling this routine.
  65.     If you are getting or setting multiple preferences, you should place
  66.     these calls within an ICBegin/ICEnd pair.
  67.     If you call this routine outside of such a pair, it implicitly
  68.     calls ICBegin(inst, icReadWritePerm).
  69.     Sets the preference specified by key from the IC database to the
  70.     value contained in prefh.
  71.     key must not be the empty string.
  72.     If prefh is nil then the preference value is not set.
  73.     If buf is not nil then the preference value is set to the data
  74.     contained in it.
  75.     If attr is ICattr_no_change then the preference attributes are not set.
  76.     Otherwise the preference attributes are set to attr.
  77.     Returns icPermErr if the previous ICBegin was passed icReadOnlyPerm.
  78.     Returns icPermErr if current attr is locked, new attr is locked and prefh <> nil.
  79. */
  80.  
  81. ICError ICCountPref(ICInstance inst,long* count);
  82. /*
  83.     You must specify a configuration before calling this routine.
  84.     You must be inside an ICBegin/End pair to call this routine.
  85.     Counts the total number of preferences.
  86.     If the routine returns an error, count is set to 0.
  87. */
  88.  
  89. ICError ICGetIndPref(ICInstance inst,long n,StringPtr key);
  90. /*
  91.     You must specify a configuration before calling this routine.
  92.     You must be inside an ICBegin/End pair to call this routine.
  93.     Returns the key of the Nth preference.
  94.     n must be positive.
  95.     Returns ilename(ICInstance inst,StringPtr filename,ICMapEntry* entry);
  96. /*
  97.     Requires IC 1.1.
  98.     You must specify a configuration before calling this routine.
  99.     If you are getting or setting multiple preferences, you should place
  100.     these calls within an ICBegin/ICEnd pair.
  101.     If you call this routine outside of such a pair, it implicitly
  102.     calls ICBegin(inst, icReadWritePerm).
  103.     Takes the name of an incoming file and returns the most appropriate
  104.     mappings database entry, based on its extension.
  105.     filename must not be the empty string.
  106.     Returns icPrefNotFoundErr if no suitable entry is found.
  107. */
  108.  
  109. ICError ICMapTypeCreator(ICInstance inst,OSType fType,OSType fCreator,StringPtr filename,ICMapEntry* entry);
  110. /*
  111.     Requires IC 1.1.
  112.     You must specify a configuration before calling this routine.
  113.     You must be inside an ICBegin/End pair to call this routine.
  114.     Takes the type and creator (and optionally the name) of an outgoing
  115.     file and returns the most appropriate mappings database entry.
  116.     The filename may be either the name of the outgoing file or
  117.     the empty string.
  118.     Returns icPrefNotFoundErr if no suitable entry found.
  119. */
  120.  
  121. /* ----- Mid Level Routines ----- */
  122.  
  123. ICError ICMapEntriesFilename(ICInstance inst,Handle entries,StringPtr filename,ICMapEntry* entry);
  124. /*
  125.     Requires IC 1.1.
  126.     You must specify a configuration before calling this routine.
  127.     You do not have to be inside an ICBegin/End pair to call this routine.
  128.     Takes the name of an incoming file and returns the most appropriate
  129.     mappings database entry, based on its extension.
  130.     entries must be a handle to a valid IC mappings database preference.
  131.     filename must not be the empty string.
  132.     Returns icPrefNotFoundErr if no suitable entry is found.
  133. */
  134.  
  135. ICError ICMapEntriesTypeCreator(ICInstance inst,Handle entries,OSType fType,OSType fCreator,StringPtr filename,ICMapEntry* entry);
  136. /*
  137.     Requires IC 1.1.
  138.     You must specify a configuration before calling this routine.
  139.     You do not have to be inside an ICBegin/End pair to call this routine.
  140.     Takes the type and creator (and optionally the name) of an outgoing
  141.     file and returns the most appropriate mappings database entry.
  142.     entries must be a handle to a valid IC mappings database preference.
  143.     The filename may be either the name of the outgoing file or
  144.     the empty string.
  145.     Returns icPrefNotFoundErr if no suitable entry found.
  146. */
  147.  
  148. /* ----- Low Level Routines ----- */
  149.  
  150. ICError ICCountMapEntries(ICInstance inst,Handle entries,long* count);
  151. /*
  152.     Requires IC 1.1.
  153.     You must specify a configuration before calling this routine.
  154.     You do not have to be inside an ICBegin/End pair to call this routine.
  155.     Counts the number of entries in the mappings database.
  156.     entries must be a handle to a valid IC mappings database preference.
  157.     count is set to the number of entries.
  158. */
  159.  
  160. ICError ICGetIndMapEntry(ICInstance inst,Handle entries,long ndx,long* pos,ICMapEntry* entry);
  161. /*
  162.     Requires IC 1.1.
  163.     You must specify a configuration before calling this routine.
  164.     You do not have to be inside an ICBegin/End pair to call this routine.
  165.     Gets the ndx'th entry in the mappings database.
  166.     entries must be a handle to a valid IC mappings database preference.
  167.     ndx must be in the range from 1 to the number of entries in the database.
  168.     The value of pos is ignored on input. pos is set to the position of
  169.     the ndx'th entry in the database and is suitable for passing back
  170.     into ICSetMapEntry.
  171.     Does not return any user data associated with the entry.
  172. */
  173.  
  174. ICError ICGetMapEntry(ICInstance inst,Handle entries,long pos,ICMapEntry* entry);
  175. /*
  176.     Requires IC 1.1.
  177.     You must specify a configuration before calling this routine.
  178.     You do not have to be inside an ICBegin/End pair to call this routine.
  179.     Returns the entry located at position pos in the mappings database.
  180.     entries must be a handle to a valid IC mappings database preference.
  181.     pos should be 0 to get the first entry. To get the subsequent entries, add
  182.     entry.total_size to pos and iterate.
  183.     Does not return any user data associated with the entry.
  184. */
  185.  
  186. ICError ICSetMapEntry(ICInstance inst,Handle entries,long pos,ICMapEntry* entry);
  187. /*
  188.     Requires IC 1.1.
  189.     You must specify